home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / fmv104.zip / FMSVER.DOC next >
Text File  |  1990-07-07  |  8KB  |  211 lines
  1. FMSVER v1.04 - July 7, 1990
  2.  
  3. PURPOSE:
  4. -------
  5.  
  6.    To verify that files listed in your RBBS-PC FMS directory actually exist,
  7.    and to update file sizes accordingly.
  8.  
  9. USAGE: 
  10. -----
  11.  
  12.         FMSVER <input.fil> <output.fil> <trashcan.fil>
  13.  
  14. CONFIGURING FMSVER:
  15. ------------------ 
  16.  
  17.    The first time FMSVER is run, it will walk you through it's configuration.
  18.    When finished, the configuration file FMSVER.CNF will be in the default
  19.    directory. This file MUST be present in order to run FMSVER against your
  20.    FMS directory(s). To create this configuration file, you will need to
  21.    know up front:
  22.  
  23.        - the number of download directories in your system,
  24.        - their names,
  25.        - the path/filename of your FMS directory, and
  26.        - the path/filename of the output file that FMSVER will create.
  27.  
  28.    The filenames can be changed from the command line (see next section),
  29.    but FMSVER will ALWAYS use the subdirectories listed in the configuration
  30.    file for it's searches.
  31.  
  32.    Do not specify the same file for both input and output!
  33.  
  34.    The output file will be a valid FMS directory, consisting of all files
  35.    that were listed in your current FMS, and were physically found in one
  36.    of the directory(s) you specified.
  37.  
  38.    The "Trashcan" file will also be a valid FMS directory, and will consist
  39.    of all files that were listed in your FMS, but were not found in the dirs
  40.    you specified. This file defaults to "NOTFOUND.TXT" in the current DOS
  41.    subdirectory. The only way to specify a different file name for the
  42.    trashcan is to use the command line option.
  43.  
  44.    A copy of my FMSVER.CNF file is included in this package as SAMPLE.CNF.
  45.  
  46. THE COMMAND LINE OPTION:
  47. -----------------------
  48.  
  49.    You can supply the input, output, and trashcan filenames (respectively)
  50.    on the command line, which will bypass what's listed in the configuration
  51.    file. If nothing is supplied on the command line, it will take the file
  52.    names from the configuration file, and the trashcan will be named
  53.    NOTFOUND.TXT in the current directory.
  54.  
  55.    The command line option lets you run FMSVER from a batch file to process
  56.    multiple FMS directories, such as:
  57.  
  58.         fmsver mstr88.dir mstr88.fix trashcan.88
  59.         fmsver mstr89.dir mstr89.fix trashcan.89
  60.               ^          ^          ^
  61.               |          |          |
  62.    NOTE that there can only be ONE blank space between these arguments if
  63.    you decide to use the command line option.
  64.  
  65.    If an invalid filename is supplied, FMSVER will error back to DOS. If
  66.    the output filename isn't specified on the command line then you'll be
  67.    prompted for it.
  68.  
  69.    Again, typing FMSVER by itself will cause it to go to the configuration
  70.    file for the input and output file names, and the "trashcan" file will
  71.    always be NOTFOUND.TXT.
  72.  
  73. CHAINED DIRECTORIES:
  74. ------------------- 
  75.  
  76.    If "\FMS CH" is found as the first seven characters on the line, then it
  77.    will be written to the output file. This line will NOT be written to the
  78.    trashcan file.
  79.  
  80. EXTENDED DESCRIPTIONS:
  81. --------------------- 
  82.  
  83.    Extended descriptions are optional in RBBS-PC, and are as such optional
  84.    as far as FMSVER is concerned. If they exist, they are treated in one of
  85.    two ways:
  86.  
  87.        - "FMS Standard method" (for lack of a better term) is how RBBS and
  88.          FMSVER treat the FMS by default (Bottom-to-top order):
  89.  
  90.                Extended 4 ...
  91.                Extended 3 ...
  92.                Extended 2 ... 
  93.                Extended 1 ...
  94.              FILENAME.EXT ...
  95.  
  96.        - "\FMS TOP method" (also for lack of a better term) is a directive
  97.          that can be given to RBBS and FMSVER instructing them to read the
  98.          FMS directory as a straight text file (top to bottom order). If
  99.          the first character of any line in the FMS is a backslash, *AND*
  100.          the string "FMS TOP" appears anywhere on that line, the FMS is
  101.          handled in straight top-to-bottom order thereafter. In this case
  102.          the extended descriptions are treated as:
  103.  
  104.              FILENAME.EXT ...
  105.                Extended 1 ...
  106.                Extended 2 ...
  107.                Extended 3 ...
  108.                Extended 4 ...
  109.  
  110.    After glancing through the RBBS docs, I found that 4 extended description
  111.    lines are supported, so that's what FMSVER can handle. If there are more
  112.    than 4 extended description lines for any given filename, lines 5 and
  113.    beyond will not be written to the output file.
  114.  
  115. PRIVATE FILENAMES:
  116. -----------------
  117.  
  118.    RBBS supports private filenames in your FMS directory, which are preceeded
  119.    by an equals '=' sign. If FMSVER finds an equals sign as the first character
  120.    on the line, it is handled as such, and it's info will be written to the
  121.    appropriate output file.
  122.  
  123. FMS COMMENT LINES:
  124. -----------------
  125.  
  126.    If RBBS finds an asterisk '*' or a backslash '\' as the first character
  127.    on any given line of your FMS, they are treated as public or private
  128.    comments respectively. If any line in your FMS begins with either of these
  129.    two characters, FMSVER will write the line to your output file immediately,
  130.    and proceed to the next line. A couple of important notes here:
  131.  
  132.    -  If either of the two types of comment lines are imbedded inside of an
  133.       extended description, the comments may not appear in your output file
  134.       in EXACTLY the same place as they were originally. (They will be either
  135.       just before or just after the extended description for that file).
  136.  
  137.    -  Also, these comment lines will NOT be written to the trashcan file in
  138.       any case.
  139.  
  140.  
  141. FILE SHARING:
  142. ------------
  143.  
  144.    I run a 3-node netbios lan under DOS Share, so file sharing was VERY
  145.    important to me when writing this program.
  146.  
  147.    The FMS directory being verified is opened in a shared fashion, which
  148.    means that someone can be online on another node listing your directories
  149.    while FMSVER is running. The files listed in your FMS are also temporarily
  150.    opened and closed in order to both check for their existence, and to
  151.    determine their size. With that in mind, they are also opened in a shared
  152.    fashion, so it is up to your download protocals as to whether or not they
  153.    will be sharable if someone is downloading one on another node when FMSVER
  154.    finds it.
  155.  
  156.    FMSVER requires DOS version 3.00 or later for the above reasons. You do
  157.    NOT have to be running a network to use FMSVER.
  158.    ~~~
  159. WHAT'S NOT SUPPORTED?
  160. --------------------
  161.  
  162.     If you find anything, let me know! 
  163.  
  164. DISCLAIMER:
  165. ----------
  166.  
  167.     It works for me, and I hope it works for you. Beyond that, no warranty
  168.     either expressed or implied.
  169.  
  170. SEMI-SHAREWARE:
  171. --------------
  172.  
  173.     If the program works for you, use it and pass it around. If you REALLY
  174.     appreciate it, feel free to send a few dollars to:
  175.  
  176.                              Chip Morrow
  177.                              The Newark Connection RBBS
  178.                              P.O. Box 2023
  179.                              Heath, OH  43056
  180.  
  181.     If $10 or more, I will send you a copy of the QB source, and the latest
  182.     version on a 5 1/4" disk. (Sorry, no 3 1/2" drives in the house).
  183.  
  184.     Note - The source requires QB 4.xx, Crescent Software's PDQ library, and
  185.            Tom Hanlin's ADVBAS in order to recompile the code unmodified.
  186.  
  187. BUGS, UPDATES, ETC.
  188. ------------------
  189.  
  190.     FMSVER1, 2, and 3.ZIP - My first three tests of the program, with a big
  191.     THANKS to Randy Sun for all the testing and feedback!
  192.  
  193.     FMSVER4.ZIP (1.00b) - Added support for different trashcan file names
  194.             via the command line.
  195.  
  196.     1.01b - Fixed a nasty EOF bug in FMSVER4.ZIP that was causing input
  197.             past end of file.
  198.  
  199.     1.03b - Added support for FMS TOP, and upped the maximum number of
  200.             download directories to 20.
  201.  
  202.     1.04  - First non-beta release. Added support for private files and
  203.             both public and private FMS comment lines.
  204.  
  205.     Would appreciate any comments, suggestions, etc.  I can be reached via
  206.     modem in one of three ways:
  207.  
  208.           - Compuserve Easyplex to user #72677,502 (Chip Morrow)
  209.           - RBBS-PC (mail addressed to SYSOP) at 614-366-4392.
  210.           - Netmail addressed to Chip Morrow at RBBS-NET address 8:965/9.
  211.